home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 3.7 / Buddy API Docs.swf / texts / 1366.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.8 KB  |  133 lines
  1. 95
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. CreatePMIcon 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baCreatePMIcon creates a Program Manager or Start Menu icon.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baCreatePMIcon( Command, Title, Icon, IconNumber  )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. String, String, String, Integer. 
  36. --- RECORDSEPARATOR ---
  37. Command is the command line to use in the icon. 
  38. --- RECORDSEPARATOR ---
  39. Title is the name that appears under the icon. 
  40. --- RECORDSEPARATOR ---
  41. Icon is the name of the icon to use. 
  42. --- RECORDSEPARATOR ---
  43. IconNumber is the number of the icon to use.
  44. --- RECORDSEPARATOR ---
  45.  
  46. --- RECORDSEPARATOR ---
  47. Returns:
  48. --- RECORDSEPARATOR ---
  49.  
  50. --- RECORDSEPARATOR ---
  51. Integer. 
  52. --- RECORDSEPARATOR ---
  53. Returns 1 if successful, else 0.
  54. --- RECORDSEPARATOR ---
  55.  
  56. --- RECORDSEPARATOR ---
  57. Examples:
  58. --- RECORDSEPARATOR ---
  59.  
  60. --- RECORDSEPARATOR ---
  61. Director: 
  62. --- RECORDSEPARATOR ---
  63. set OK = baCreatePMIcon( "d:\mterms.exe","Multimedia Terms","d:\mterms.ico", 0 ) 
  64. --- RECORDSEPARATOR ---
  65. Authorware: 
  66. --- RECORDSEPARATOR ---
  67. OK := baCreatePMIcon( "d:\\mterms.exe", "Multimedia Terms", "d:\\mterms.ico", 0 )
  68. --- RECORDSEPARATOR ---
  69.  
  70. --- RECORDSEPARATOR ---
  71. Notes:
  72. --- RECORDSEPARATOR ---
  73.  
  74. --- RECORDSEPARATOR ---
  75. The icon will be added to the active Program Manager group. To ensure that the 
  76. --- RECORDSEPARATOR ---
  77. group you want to add the icon to is active, you should always call 
  78. --- RECORDSEPARATOR ---
  79. baCreatePMGroup before you use this function (even if the group already exists). 
  80. --- RECORDSEPARATOR ---
  81. This will make the group the active one. If you are adding multiple icons, you only 
  82. --- RECORDSEPARATOR ---
  83. need to make one call to baCreatePMGroup before you start adding. 
  84. --- RECORDSEPARATOR ---
  85. If you create a group, and want to add icons to it, you should allow enough time for 
  86. --- RECORDSEPARATOR ---
  87. Windows to create the group before you try to add an icon to it. A wait of one 
  88. --- RECORDSEPARATOR ---
  89. second should be enough, but slow machines running Win95 may take longer. 
  90. --- RECORDSEPARATOR ---
  91. The Icon parameter can be either an .ico, .exe or .dll file. If the file is a .ico, then 
  92. --- RECORDSEPARATOR ---
  93. the IconNumber parameter is ignored. If it is a .exe or .dll file, then the IconNumber 
  94. --- RECORDSEPARATOR ---
  95. is the number of the icon in that file to use. If the Icon is an empty string (""), then 
  96. --- RECORDSEPARATOR ---
  97. the first icon in the Command .exe file will be used. 
  98. --- RECORDSEPARATOR ---
  99. For example: 
  100. --- RECORDSEPARATOR ---
  101. baCreatePMIcon( "d:\mterms.exe", "Multimedia Terms" , "" , 0 ) 
  102. --- RECORDSEPARATOR ---
  103. will use the default icon for d:\mterms.exe. 
  104. --- RECORDSEPARATOR ---
  105. baCreatePMIcon( "d:\mterms.exe", "Multimedia Terms" , "d:\mterms.ico" , 0 ) 
  106. --- RECORDSEPARATOR ---
  107. will use the d:\mterms.ico icon. 
  108. --- RECORDSEPARATOR ---
  109. baCreatePMIcon( "d:\mterms.exe", "Multimedia Terms", "c:\win\moreicons.dll", 5 ) 
  110. --- RECORDSEPARATOR ---
  111. will use the fifth icon in moreicons.dll. 
  112. --- RECORDSEPARATOR ---
  113. You need to ensure that the filenames you pass into the function do not contain a 
  114. --- RECORDSEPARATOR ---
  115. space ΓÇô use the baShortFilename function to return the short version of a filename.
  116. --- RECORDSEPARATOR ---
  117.  
  118. --- RECORDSEPARATOR ---
  119. See also:
  120. --- RECORDSEPARATOR ---
  121.  
  122. --- RECORDSEPARATOR ---
  123. baCreatePMGroup 
  124. --- RECORDSEPARATOR ---
  125. baDeletePMGroup 
  126. --- RECORDSEPARATOR ---
  127. baPMGroupList 
  128. --- RECORDSEPARATOR ---
  129. baPMSubGroupList 
  130. --- RECORDSEPARATOR ---
  131. baDeletePMIcon 
  132. --- RECORDSEPARATOR ---
  133. baPMIconList